Night Owl 6/Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso/049a/bn102b.zip/BILLNODE.DOC

Text File | 1990-08-17 | 23KB | 540 lines

                   B I L L S T A T   &   B I L L N O D E
                      Node Billing Software for QMail


                               Version 1.02

                        Release Date August 1, 1990


                    Copyright 1990, ALL RIGHTS RESERVED
                  (c) Tower Enterprises -- Jeff Galbraith


T a b l e   o f   C o n t e n t s
___________________________________________________________

               Requirements........................3
               License.............................3
               Distribution........................3
               Warranty............................4
               Introduction........................5
               Disclaimer..........................5
               Trademarks..........................5
               Quick and Dirty.....................6
               Full Installation...................8
               BILLCFG.............................8
               BILLSTAT............................8
               BILLNODE............................9
               Future Releases....................11
               Trade Marks........................11
               Registration.......................12
               Registration Form..................12



R e q u i r e m e n t s
___________________________________________________________


IBM or Compatible PC
DOS 2.2 or greater
Using QMail



L I C E N S E
___________________________________________________________


Copyright 1990  by  Tower  Enterprises  --  Jeff  Galbraith.    ALL  RIGHTS
RESERVED. COMMERCIAL  DISTRIBUTION AND/OR  USE OF THE PROGRAMS MENTIONED IN
THIS DOCUMENTATION,  WHICH WERE  PROGRAMMED  BY  THE  AUTHOR,  IS  STRICTLY
PROHIBITED WITHOUT WRITTEN CONSENT FROM THE AUTHOR.

For Non-commercial users, a payment of $40.00 US ($45.00 CDN) is requested.
If you  feel the  programs contained  herein this  archive package  are  of
benefit to  you, please  register your  copy. However,  the payment  is not
mandatory. The  most that  is required for registration is a post card with
your  name,   your  Net/Node   address,  data   phone,   an   address   for
correspondence,  personal   telephone  for   correspondence,   and/or   any
applicable comments.  This is  basically to let me know that the program is
being  used  and  needs  to  be  updated.  Also,  any  bug  reports  and/or
suggestions would be nice. See 'REGISTRATION' for details.


D I S T R I B U T I O N
___________________________________________________________


Distribution of  the programs  contained within  this archive and/or use of
these programs is permitted under the following terms:

1)   The executable files, documentation, and support files are distributed
     as  one  archive,  without  alteration  or  addition  to  any  of  the
     executable files,  documentation, and  support files. This also covers
     any additional files that may be put in the archive. The archived file
     must be distributed with the same files, neither adding or taking away
     from the original archive.

2)   That no  charge is to be levied for the distribution of the archive. A
     cost of  no more  than $2.50  US may be charged for the media to which
     the archive  is distributed  on. Any charge over this, must be sent to
     the author  or any  charitable organization. The author "must" receive
     an original  or photocopy  of the  Charity's receipt  if this  is  the
     option you take.




3)   For the  purposes of  explanation, "COMMERCIAL  USE" is defined as any
     corporation, government,  company, church,  or any  other organization
     for the purpose of making a profit. This also includes BBS that levies
     any fee for it's use.




W A R R A N T Y
___________________________________________________________


The  software   included  within   the  archive   as  well   as  with  this
documentation, contains  NO WARRANTY, neither expressed or implied. The use
of this  software is totally at the users own risk. By using this software,
you also release the author of any liabilities or infringements.  In no way
will Jeff  Galbraith or  Tower Enterprises be held responsible for damages,
including lost  profits or  monies, or  any other  special,  incidental  or
consequential damages  arising out  of the  use of  the BILLNODE program or
it's subsidiary components.

You may contact the author at the address below:

Jeff Galbraith
236 Midglen Terrace S.E.
Calgary, Alberta
Canada - T2X 1R2


FidoNet 1:134/21    (Mail Only node - receives Netmail only)
FidoNet 1:134/40    (14.4 HST)

Feel free  to contact the author any time to share your comments about this
software and/or licensing agreements, or bug reports/enhancements.



I N T R O D U C T I O N
___________________________________________________________


This has  been a fun ordeal, I have to admit to that. What started out as a
project back in December 1989, has finally evolved into the programs that I
now present  before you  for your  use. There  was a version of the Billing
software before  this one,  v1.00 (released  in January  for  beta  testing
only). However,  that software  was created out of a very necessary need to
have some  sort of  reliable billing process. Since then, our Net has grown
substantially and  because of  this, the  limitations that  were written in
that "quick-and-dirty" first version, were exceeded as everything was being
done in  memory. Now,  I am  using an  advanced database  technique for the
storage of  data while the program is being run. Once the ASCII data  files
are written, the database files are destroyed as they are no longer needed.
What this  mean, is  that there  is no limitation to the software any more.
The only  limitation is the amount of storage space left on your hard drive
during processing  time. In  most cases  approximately one  megabyte is all
that should be necessary.

At the  release time  of this  software, one  other third-party  program is
depended on  for the  billing files  and reports  to  be  posted.  That  is
SENDMAIL. As  soon as  possible, I  will be working on a compatible program
that can be shipped with this archive package.

| I have now completed MAKEMSG which BILLNODE takes full advantage of. This
| utility program can also as a stand-alone program  for any other uses you
| feel  fit to use it in. Suggestions range from posting echo rules (if you
| are a moderator), to posting other reports as generated by other BBS
|  utility programmers.

I would  like to  thank Henning Johansen (FidoNet 134/40) for a lot of help
and understanding  most of the way through this entire project. I'd like to
thank Tim  Bellaart (FidoNet  134/17  -  current  NEC)  for  his  time  and
contributions as well.

One more finale note about licensing. Please, if you don't feel the need to
pay the shareware fees, that's fine, but I wold appreciate a postcard. This
will only  help me  in keeping  track of  the program  for update purposes.
Also, if  it's not  being used at all (I hope it isn't as it is a darn good
program), I guess there wouldn't be any need to update it to make it faster
or more efficient. In other words, I like to know if my programming time is
being useful.

I'd also like to say this is another "PROUDLY CANADIAN" shareware product!



Q U I C K   A N D   D I R T Y
___________________________________________________________


Create a  subdirectory called  BILLS of  your route  directory.  UnZip  the
BILLNODE program  into this  directory. Make  sure this directory gets into
your DOS  path. If you put the BILLS  on C: drive, create another directory
called C:\BILLS\WORK. Now make another called C:\BILLS\DATA.

Now edit  the IGNORE.LST  file. This is an ignore list that causes BILLSTAT
to ignore  certain echo areas and nodes from being counted, thus in effect,
discounting them from being billed. For example, put your echo feeds in the
IGNORE.LST file  so Bills won't be generated for them. Make sure any echoes
which are not billed also get put in. For example, if you have local echoes
on the  same machine,  you don't  want to get billed for these, so put them
in.

Now, run  BILLCFG and  fill in all applicable information. This step has to
be done before BILLSTAT will run. Use the F1 key for help.

Now create  a batch  file. This  batch file should probably run when you do
your maintenance  event. Make  sure your  batch file copies the QM.LOG file
into your  C:\BILLS\WORK directory. Also, copy your AREAS.BBS file in there
as well.  The batch  file should  now call  BILLSTAT. If you want a report,
make  sure  you  use  the  -r  option.  After  it  is  finished,  copy  the
BILLSTAT.[jul] (where  [jul] is  the current  Julian date)  file  into  the
C:\BILLS\DATA directory.  If you  created a  report for a report echo, post
it. Here is an example batch file:

: *************************************************************************
:      BATCH FILE TO CREATE BILLSTAT DATA MODULES AND BILLSTAT.RPT
:      Created 17/08/90                     Author: Jeff Galbraith
: ************************************************************************

@echo off
cd \BILLS\WORK
copy C:\MAX\AREAS.BBS
copy C:\LOGS\QM.LOG
Billstat -s128 -iC:\BILLS\IGNORE.LST -r
Copy BILLSTAT.* ..\DATA
MAKEMSG -cBILLSTAT.RPT -dD:\MAIL\REPORTS -s134/21
rem These next lines are optional if you want to save your "raw" data
PKZIP -m areas_qm areas.bbs qm.log
DAYSTAMP areas_qm 9
MOVE areas_qm.* ..\OLD_LOGS /e/y

: *************************************************************************

This is an example only!



At  the  end  of  the  month,  change  directories  to  your  C:\BILLS\DATA
directory. Then  load BILLNODE.  This is  an interactive  program requiring
user input  as  defined  by  your  telephone  bill.  Input  all  applicable
information and  let here  rip. If everything went well, BILLNODE creates a
batch file  called POST.BAT. Change directories to your matrix area and run
the POST.BAT  file by  typing the  following at the command line (AFTER YOU
ARE IN YOUR MATRIX AREA!)

C:\BILLS\DATA\POST

This will  post all  of the  bills to  messages in  your matrix  area using
MAKEMSG. Two  other files  were create by BILLNODE. One called BILLNODE.SUM
which is  a condensed  file containing only the billing totals of each node
and BILLNODE.RPT  which is  basically the  same as  BILLSTAT.RPT but  is  a
cumulative report  for the  month. Both  of these files support the MAKEMSG
format for easy echomail posting into a report area for the Net.

You are  responsible for  the cleanup  of all  files in  the DATA directory
including the  billing files  which are  hexadecimal  numbers  representing
net/node numbers.  These files have no extensions and should be easy enough
to clean  up. The  used BILLSTAT.[jul]  files are your responsibility. I am
taking suggestions  if users  want BILLNODE to do something with them, like
move them to a separate directory. Give me feedback and we'll get something
going.

So there  you have  it. I  suggest continue  reading so  you understand the
command line  options and other intricate details that the programs have to
offer.



F U L L   I N S T A L L A T I O N
___________________________________________________________


Place all  the files into a directory which is in your DOS Path. This is so
you will  be able  to run  them from  anywhere on  your hard drive with out
problems. Most  importantly, the  database dictionary,  BILLSTAT.DBD,  MUST
reside in  the same  directories as the executable files. BILLNODE.HLP must
also reside in this directory.


B I L L C F G
___________________________________________________________


To get  started, you  must first  run the configuration file, BILLCFG. This
file creates  a configuration  file which  both BILLSTAT  and BILLNODE read
during there  execution periods.  Please be concise and fill in everything.
Help, using  F1, is  provided. This  configuration file, BILLNODE.CFG, must
reside in the same directory as the executables.


B I L L S T A T
___________________________________________________________


Once the  configuration file  is created,  it is  okay to  run the BILLSTAT
program. The  billstat program  requires  two  files  to  be  in  the  same
directory. The  files are  QM.LOG and  your AREAS.BBS  file. There  are  no
exceptions to  these names,  so if  you have them named otherwise, you will
need to  rename them  respectively. It  is best to use a work directory and
copy these  two files  in  there.  Then  change  directories  to  the  work
directory.

BILLSTAT parses  the QM.LOG  file for  the echoes that arrived and how many
messages in  each. It uses the AREAS.BBS file to match areas with nodes. It
would be  a good  idea to store a copy of your QM.LOG and AREAS.BBS in case
you needed to regenerate the data file again.

BILLSTAT has a number of options. Here is the syntax:

BILLSTAT [-h] [-s<num>] [-i<[path]list>] [-r]

-h   This option  will give  you the  help screen.  This should be the only
     option when used as it overrides all other options and then exits.
-s   This is  to Set  the internal  cache page size. The default is 32, but
     you will get a much faster performance if you can set it to 384. to do
     this use  -s384. you  may need to test which size to use to see what's
     best for  your system.  If the  program stops, after starting (it will
     tell you  if there  is enough  memory), try again with a lower number.
     Try and  use multiples  of 32  or 64  for best  performance. A  higher
     number does less disk seeks and can speed up the application by 50%.
-i   This is  the ignore list. It goes like this -iList.dat, where List.dat
     (or any  other file  name) is a file containing a list of nodes and/or
     echoes to ignore. This is so your echofeed hub doesn't get charged, or
     a "free" echo doesn't get charged out as well. This gives you a lot of
     control of  what gets  charge and  who gets charged. To ignore a node,
     the syntax  in the  file should be @NODE=134/21 and to ignore an echo,
     the syntax  should be  @ECHO=cellblk17. The @NODE=and @ECHO= should be
     capitalized and  each instance  should reside  on a  new  line.  THERE
     SHOULD BE NO SPACES ANYWHERE, NOT EVEN AFTER THE LINE.
-r   This is  to tell  BILLSTAT to create a daily report. The report's name
     is BILLSTAT.RPT and has header information for MAKEMSG to post it to a
     report echo.



A typical call to BILLSTAT would look like the following:

BILLSTAT -s384 -iLIST.DAT -r

The following two files would be created:
1) BILLSTAT.RPT (from the -r) and
2) BILLSTAT.[jul] (where jul is the current date's Julian day of the year).

You need  to keep the BILLSTAT.[jul] files somewhere safe. Typically, these
file range  from 2-16  thousand bytes  and compress  very  easily  into  an
archived file.  These are  the files  that BILLNODE  uses when it does it's
monthly billing processes.

The report  file can  be put  into a  report  echo  so  that  any  who  are
interested can  see the  daily statistics of how many messages cam into the
net and who many messages each node was billed.

This can  all be accomplished via a batch file set up for your system and a
little ingenuity.


B I L L N O D E
___________________________________________________________


BILLNODE is an interactive program that needs operator care. BILLNODE has
two options. Here is the syntax:

BILLNODE [-h] [s<num>]

-h   This option  will give  you the  help screen.  This should be the only
     option when used as it overrides all other options and then exits.
-s   This is  to Set  the internal  cache page size. The default is 32, but
     you will get a much faster performance if you can set it to 384. to do
     this use  -s384. you  may need to test which size to use to see what's
     best for  your system.  If the  program stops, after starting (it will
     tell you  if there  is enough  memory), try again with a lower number.
     Try and  use multiples  of 32  or 64  for best  performance. A  higher
     number does less disk seeks and can speed up the application by 50%.

A typical call to BILLNODE would look like the following:

BILLNODE -s384

An interactive  screen, allowing  you to  enter data, comes up. Help is now
available for each field, through the use of the F1 key. Some of the fields
should already  be filled  according to what was put into the configuration
file via BILLCFG.

Here is the screen:

        BILLNODE v1.02 Copyright 1990, ALL RIGHTS RESERVED.
      (c) Tower Enterprises -- Jeff Galbraith, FidoNet (1:134/21)

    START DATE <DD-MM-YY>:   -  -          TOTAL BILL:
    END DATE      <DD-MM-YY>:   -  -

SENDING NODE:  134/1
    TO:              All
    FROM:        NEC 134
    SUBJECT: NET 134 ECHOMAIL BILLINGS

       COSTS    COMMENTS
    1.$   0.00  Toll Charges
    2.$   0.00  11% Communications Tax
    3.$   0.00  Phone Line Rental
    4.$   0.00  NC Charge
    5.$   0.00  20% Equipment/Misc. Fund



The first  thing you  do is  add a  start date  and an  ending date  of the
billing. This  is most  appropriately the  to and  from dates  off of  your
telephone bill.

Then you  need to  add the "SENDING NODE" number. This is your node address
and is used by MAKEMSG for the creation of the billing messages.

Then, add  the TO,  FROM and SUBJECT fields. This is all used by MAKEMSG as
well in creating the messages.

Now, add  the cost  (COSTS) of  each item  being billed, plus an additional
comment (COMMENTS - the comments shown are example only) beside it. This is
placed on  each bill  so that the billed node knows what the costs were and
how much.

When you  get to the last comment field and press enter, the program starts
parsing the  applicable BILLSTAT.[jul]  files for the information it needs.
It displays  a run down of everything it is doing. When it is finished, you
will have the following files:

BILLNODE.RPT
     - a monthly report similar to BILLSTAT.RPT.
BILLNODE.SUM
     - a summary file of charges and what each node is to be invoiced.
POST.BAT
     - a  batch file  to post  the billing  files to  the matrix area using
       MAKEMSG.
[hex_num]
     - this  is a  file containing  the information each node is to receive
       concerning it's  billing status.  The file  name is  the hexadecimal
       number of  the node  address to  receive the  billing. For  example:
       134/21 becomes  filename 00860015. There should be a number of these
       files depending on how big your net is.

The POST.BAT  that was  created, uses the path where the hex filenames were
created, so  it is best to post them right away.  Again, another batch file
is best  for this.  This batch file could change directories to your matrix
area and then call the POST.BAT batch file.

[=========================================================================]
NOTE ABOUT MAKEMSG:

MAKEMSG must  be in the directory where the message is to be created unless
the path  is given  with the  -d option.  If you  are posting  the  billing
statements, you need to be in the matrix area when you run POST.BAT as well
as have  MAKEMSG.EXE in  your path. If you are posting reports, you need to
be in the directory of where the messages are to be posted.
[=========================================================================]



If at  anytime, BILLNODE cannot find an appropriate BILLSTAT.[jul] file, it
will pause  and ask  whether it  should ignore  this and  continue. If  you
choose 'No', the program will exit. If you choose 'Yes', then BILLNODE will
average the  bill out  with the  data that  is available.  If you have been
receiving regular  echomail (is  that an  OXYMORON?), then  the bills  will
probably be what they would have been anyhow. If you haven't been receiving
regular echomail,  really, there's nothing you can do. The bill may sway to
or from different nodes (still beats doing it by hand).

The billings for each of the nodes may have a difference if you add up each
cost of  each echo  billed and  compare that with the billed total. This is
because there is no rounding up of the individual echo charges as this goes
to six decimal places. However, the charged total is correct.



F U T U R E  R E L E A S E S
___________________________________________________________


In the future BILLNODE will have a control file that will allow you to
basically design a form and have BILLNODE use it as a template for writing
out your billing statements. This way, you add things like addresses to
send the cheques to, etc.

If you have ideas for future releases, please let me know. Any way to make
this software run better and more efficiently, the more everyone will be
satisfied. Anyone who gives me an original suggestion that is later
incorporated, will get credit for it.



T r a d e m a r k s
___________________________________________________________


IBM is a registered trademark of International Business Machines.
QuickBasic is the registered trademark of MicroSoft Corporation.
MS-DOS is the registered trademark of MicroSoft Corporation.
Turbo C is the registered trademark of Borland International.
Anyone and/or Corporation left from this list does not mean that I do not
give them credit.



R E G I S T R A T I O N
___________________________________________________________


As I mentioned before, it is not required to pay a registration for this
product. You may (I encourage all shareware devotees to) pay with your
registration if you wish. As this software is made for the NET in mind and
not just a single person, it really shouldn't be too hard to throw in the
bucks. However, if you do not wish to pay, I am still asking that you
register the product so I know how many installations are out there and
whether continued service warrants the up keeping of these programs (I hope
so as believe they are pretty darned good! <grin>). Anyway, fill out the
form below, or send me a postcard with the same information. My sincerest
thank you.

---------------------------------------------------------------------------


                             Registration Form



FULL NET ADDRESS :

NEC'S ADDRESS    :

NC'S ADDRESS     :

REGISTRANT'S NAME:
(usually NEC)

DATA NUMBER      :

VOICE NUMBER     :

REGISTRATION INCLUDED?: Yes[ ]  No[ ]
($45.00CDN - $40.00US, non-Canadian orders add $5.00)

COMMENTS: